docs(readme): fit the badges on one row and drop a rule from the header#1567
Merged
Conversation
Six badges in the for-the-badge style are wider than a typical readme column, so the row wrapped with a single badge stranded underneath. The licence badge goes: GitHub already shows the licence as a tab directly above the readme, so it was the one carrying no information the reader did not already have. The tagline becomes an HTML heading. GitHub draws a rule under h1 and h2, which put a line between the tagline and the guide links for no reason. An h3 keeps the size without the rule, and markdownlint's allow-list gains the element.
danielcopper
enabled auto-merge (squash)
July 22, 2026 20:38
danielcopper
disabled auto-merge
July 22, 2026 20:41
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Two small fixes to the header that #1566 introduced.
The badge row wrapped. Six badges in the
for-the-badgestyle are wider than a typical readme column, so the last one stranded on a second line, which reads as an accident rather than a layout. The licence badge is removed: GitHub already shows the licence as a tab directly above the readme, so it was the one badge carrying nothing the reader did not already have. Five remain and fit.The tagline had a rule under it. GitHub draws one under
h1andh2, which put a line between the tagline and the guide links for no reason. It becomes anh3element, which keeps the size without the rule;markdownlint's allow-list gainsh3.docs: N/A — the readme is the change; no documentation page describes it.